Updating from "Intro" to "How-to" #956
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
idalithb
commented
May 17, 2025
idalithb
commented
- Turning this into a how-to-guide
- Might revisit to add more at a later time
benface
reviewed
May 17, 2025
| @@ -1,7 +1,7 @@ | |||
| import titles from './_meta-titles.json' | |||
|
|
|||
| export default { | |||
| introduction: '', | |||
| introduction: 'How to Query', | |||
There was a problem hiding this comment.
Suggested change
| introduction: 'How to Query', | |
| introduction: '', |
Page titles should never be set in _meta.js files, but directly in the MDX's frontmatter, either as title or as sidebarTitle (as you've also done!), so that they remain translatable.
benface
reviewed
May 17, 2025
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| You will notice that this query URL must use a unique API key. You can create and manage your API keys in [Subgraph Studio](https://thegraph.com/studio), under the "API Keys" section. Learn more about how to use Subgraph Studio [here](/deploying/subgraph-studio/). | ||
| > Please see the [Query API](/subgraphs/querying/graphql-api/) for a complete reference on how to query the Subgraph's entities. |
There was a problem hiding this comment.
Suggested change
| > Please see the [Query API](/subgraphs/querying/graphql-api/) for a complete reference on how to query the Subgraph's entities. | |
| > Please see the [GraphQL API](/subgraphs/querying/graphql-api/) for a complete reference on how to query the Subgraph's entities. |
benface
reviewed
May 17, 2025
|
|
||
| ### Step 3: Manage Your API Key | ||
|
|
||
| Each query URL requires a valid API key. In [Subgraph Studio](https://thegraph.com/studio), locate the **API Keys** section to create or manage your keys. Learn more about how to use Subgraph Studio [here](/subgraphs/developing/deploying/using-subgraph-studio/). |
There was a problem hiding this comment.
Why not link directly to the API Keys page?
Suggested change
| Each query URL requires a valid API key. In [Subgraph Studio](https://thegraph.com/studio), locate the **API Keys** section to create or manage your keys. Learn more about how to use Subgraph Studio [here](/subgraphs/developing/deploying/using-subgraph-studio/). | |
| Each query URL requires a valid API key. Go to Subgraph Studio's [API Keys page](https://thegraph.com/studio/apikeys/) to create or manage your keys. Learn more about how to use Subgraph Studio [here](/subgraphs/developing/deploying/using-subgraph-studio/). |
benface
reviewed
May 17, 2025
Comment on lines
+18
to
+22
| Click the “Query” tab to explore the deployed GraphQL API for each Subgraph. | ||
|
|
||
| ### Step 2: Retrieve the Query URL | ||
|
|
||
| On the Subgraph details page, select **Query** in the top right corner. Each Subgraph published to The Graph Network has a unique query URL in Graph Explorer to make direct queries. |
There was a problem hiding this comment.
I feel like there's a bit of repetition between lines 18 and 22. I realize there is both a "Query" tab (which is the default selected tab when navigating to a Subgraph's details page, so there's really no need to click on it) and a "Query" button, but the latter only scrolls down to the "Query quick start" section of the "Query" tab, where the Query URL (among other things like Base URL and Subgraph ID) can be found and copied.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.